home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 March / macformat-048.iso / Shareware Plus / Applications / Birthdays and Such folder / Manuals in various formats / Birthdays manual (TeachText) / Birthdays manual (TeachText) 1 next >
Encoding:
Text File  |  1996-12-21  |  19.6 KB  |  255 lines  |  [TEXT/ttxt]

  1.  
  2.  
  3.  
  4.  
  5. Birthdays and Such…
  6.  
  7.  
  8. by Ron Lichty
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21. User’s Guide
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41. version 1.0.2
  42.  
  43. December 1996
  44.  
  45.  
  46.  
  47. Copyright © 1993-1996 Ron Lichty. All Rights Reserved.
  48.  
  49.  
  50. Chapter 1 : Introduction
  51.  
  52. Birthdays and Such… is an application meant to be launched on daily startup, to remind you of the important birthdays and anniversaries in your life. It works for me, which has made me the envy of all my friends and relatives. By setting reminders 10 or so days ahead, I find I’m as on the ball as the best of the rest of my friends and relatives in remembering to buy cards and presents (and to actually send them)—and way ahead of the date-impaired. 
  53.  
  54. Now admittedly you’re going to have to type in a list of all the important dates you want to remember. But this is a one-time task. From then on, you’re home free (ok, ok, you still have to add and remove friends and relatives as they’re born and die...). But that certainly beats my previous annual efforts to write every date onto the family calendar or into my day-timer. And it results in a list that, printed out from your word processing program, makes it easy to buy your whole year’s cards in one shopping trip!
  55.  
  56. The steps are simple (with details below): Install Birthdays and Such by copying a few files to your hard disk. Type your list of important dates into a text file you call “Reminders” (yes, the name is required). Put the Reminders file where Birthdays and Such… can find it. And set Birthdays and Such… to run every time you start your Macintosh. 
  57.  
  58.  
  59. Then every time you turn on your Macintosh, it will start up Birthdays and Such… The program will look up the current date, scan the Reminders file for upcoming events, and display just those you need to do something about. 
  60.  
  61. It’s at this point—before I choose Quit from the File menu in Birthdays and Such…—that I write myself a little note (and put it in my pocket) to buy a card, or I pull out the card I bought earlier.
  62.  
  63. And if you leave your Macintosh running for days at a time, just leave Birthdays and Such… running: its window will update to the next day’s reminders every night on the stroke of midnight. (I specifically designed Birthdays and Such… both to launch super quickly and to run all the time: it’s absolutely the smallest executable I could make it. In fact, it’s probably the smallest executable on your machine! It’s only 17K.)
  64.  
  65. The program name “Birthdays and Such…” 
  66.  
  67. Birthdays and Such… ends with an ellipsis character because there are so many dates beyond birthdays and such to remember…  (I have added reminders for such purposes as filing for reimbursement of certain recurring expenses, changing my 401K contributions, paying for my Grand Canyon reservations, and visiting my dentist, for example.)
  68.  
  69. Version 1.0 
  70.  
  71. Version 1.0 has been extensively tested, and it is my belief that there are no bugs of any kind (I know, I know, famous last words and all). Well, how about this: I’ve been using Birthdays and Such… for almost two and a half years now on Macs ranging from SEs to Quadras, Performas to PowerMacs, and from System 6 to System 7—all without a glitch.
  72.  
  73. What you need to run Birthdays and Such… 
  74.  
  75. Birthdays and Such… runs on almost every Macintosh computer that’s been made. There is almost no Macintosh in use today that does not meet the following minimum system requirements:
  76.  
  77.     • a Macintosh computer made in 1986 or later (that is, not  a Mac 128 or Mac 512)
  78.  
  79.     • system software version 6.0 or later (actually, System 6.0.4 or later may be required)
  80.  
  81. If you’re not sure which system you have, choose the About The Finder or About This Macintosh command from the Apple menu (these commands only appear when you’re in the Finder).
  82.  
  83. Distribution 
  84.  
  85. Birthdays and Such… is shareware. (No, not for my relatives and friends. Don’t be silly. I sent it to each of you as a gift. But if you’re not already one of my friends, relatives and acquaintances, Birthdays and Such… is  shareware.) 
  86.  
  87. Birthdays and Such… is NOT  a free or public domain program.
  88.  
  89. As with most shareware, please try it for yourself for a day, a week, a month. Unlike most shareware,  however, Birthdays and Such… is What’sItWorthWare—that is, I believe in user-determined pricing. You decide what Birthdays and Such… is worth. Then send me a money order or a check (see Chapter 7). (What’s it worth to save your marriage? What’s it worth to maintain your relationship with your parents? OK, maybe Birthdays and Such… won’t do that all by itself, but...  :-)
  90.  
  91. Please keep Birthdays and Such…, the sample Reminders file, the manual, and any addendum or readme files bundled together, if you pass it on to someone else.
  92.  
  93.  
  94. Chapter 2 : Installing Birthdays and Such…
  95.  
  96. To install Birthdays and Such… from a floppy disk (or CDROM) onto your hard drive (you can skip these steps if you downloaded and uncompressed Birthdays and Such… from a network source):
  97. 1)    Turn on your Macintosh.
  98. 2)    Insert the floppy disk labeled Birthdays and Such in the floppy disk drive of your Macintosh.
  99. 3)    Copy the folder labeled Birthdays and Such folder to your hard disk. 
  100. 4)    Eject the Birthdays and Such disk.
  101. Basic installation is now complete. 
  102.  
  103. Auto-Startup Installation:
  104. Most people will want Birthdays and Such… to run every time they turn on their Macintosh computer, so they’ll be reminded of upcoming birthdays and anniversaries at least that often. If you would like the program to run every time you turn on your Macintosh, continue with the following instructions. 
  105. 1)    Open the Birthdays and Such folder on your hard disk (the one you just moved there) 
  106. 2)    Select the icon labeled Birthdays and Such… (click once on the icon). 
  107.  
  108. Remaining installation instructions for System 6 users:
  109. If you use System 7, skip to the section titled “Remaining installation instructions for System 7 users.” This section is for System 6 users:
  110. 3)    Choose the Set Startup command from the Special menu.
  111. 4)    Click the radio button labeled Birthdays and Such…  (If Birthdays and Such… is not one of the options, click the Cancel button and go back two steps in these instructions to step 1.)
  112. 5)    Click the OK button.
  113. If you’re a System 6 user, auto-startup installation is now complete. Now every time you turn on your Macintosh computer, Birthdays and Such… will start up, look through the Reminders file, and remind you of the upcoming events in your life.
  114.  
  115. Remaining installation instructions for System 7 users:
  116. 3)    Choose the Make Alias command from the File menu. 
  117. 4)    Drag the new file labeled Birthdays and Such… alias into the Startup Items folder, which is located inside the System Folder.
  118. Auto-startup installation is now complete. Now every time you turn on your Macintosh computer, Birthdays and Such… will start up, look through the Reminders file, and remind you of the upcoming events in your life.
  119. Optional Step: To force the Birthdays and Such… reminders window to appear as the top window (to be “in your face”, so to speak), rename the application and the alias to begin with a ‘•’ (type the key combination, option-8). (This works because the bullet sorts alphabetically after all the letters and numbers, and after many special characters.) (Note, however, that Startup Items that are desk accessories or documents will foil this plan: they will open on top anyway, since DAs and documents open after applications.)
  120. Now double-click Birthdays and Such… The four changes of season are in the sample Reminders file, each with a long enough reminder period to guarantee there’s a reminder every single day—so you can get a flavor of Birthdays and Such… right away.
  121.  
  122. Chapter 3 : Setting Up Your Reminders
  123.  
  124. The file you create of all your important dates, a text file which must be named “Reminders”, is the source of information for Birthdays and Such… 
  125.  
  126. Each Reminder in the Reminders file can be assigned its own number of days ahead that you want to be reminded that the event is upcoming.
  127.  
  128. Acceptable locations for the Reminders file  
  129.  
  130. The Reminders file (which must have the name “Reminders”) must be located in one of two places:
  131.     • in the same folder as Birthdays and Such… , or
  132.     • in the System Folder
  133.  
  134. Birthdays and Such… reads in the file, looks through all the reminders in it, and evaluates them to find those which are, today, applicable (those for which today’s date is within the reminder period). Then it displays those reminders in a list on the screen.
  135.  
  136. How to edit the Reminders file
  137.  
  138. Reminders is a text file that can be created by any word processor that can save a file as ‘text’. 
  139.  
  140. The simplest way to edit Reminders is to use TeachText or SimpleText, one of which is located on almost every Macintosh. (Instructions for using other word processors to edit Reminders can be found at the end of this chapter.)
  141.  
  142. The sample Reminders file was created in SimpleText (on earlier Macintoshes called TeachText). To edit Reminders, simply double-click its icon. If you have TeachText or SimpleText, it will launch, opening the Reminders file. When you’ve made your changes, choose Save from the File menu. Then close the document (choose Close from the File menu). Double-click Birthdays and Such… to see the results (if any would be displayed today) of your changes.
  143.  
  144.  
  145. The format for each Reminder 
  146.  
  147. The format in the text file named “Reminders” is a series of records, each several lines long, each line a single field. You have to press the return key when you add new lines to the document, and not just let the line wrap (Nerd translation: each line must be terminated by a carriage return character).
  148.  
  149. The fields are in the following order:
  150.     date     date of reminder
  151.     warning-period    number of days prior to date  to begin reminding (0 to 99)
  152.     Reminder     the text to display as a reminder
  153.     -    record separator (a dash as the first character on the line)
  154.  
  155. Reminders consist of just the first three fields, followed by the record separator line (a single dash as the first character on the line). No blank lines are permitted.
  156.  
  157. Here’s an example file with three reminders:
  158.  
  159. January 14
  160. 2
  161. David’s birthday (1955).
  162. -
  163. January 23
  164. 0
  165. Grandma’s birthday .
  166. July 19
  167. 10
  168. Author Ron Lichty’s birthday, P.O. Box 27262, SF, CA 94127.
  169.  
  170. So in the example, you would be reminded of David’s birthday from January 12-14, Grandma’s birthday only on January 23rd itself, and Ron’s birthday from July 9-19, long enough to buy him lots of presents.
  171.  
  172. While the example shows the birthdays in date order, that’s not necessary. But I personally find it easier to look through the Reminders file and keep track of everyone by doing it that way. 
  173.  
  174.  
  175. The date  Field: International Date Formats 
  176.  
  177. Dates should be written in a form that is native to the language and region of the system software you are using. (Nerd note: a part of system software called the Script Manager is used to read the dates from the file; the date routines weren’t added to the Script Manager until version 2.0, which was released with System 6, which is why System 6 or later is required.)
  178.  
  179. The most common valid English date formats, for example, would be:
  180.     September 20
  181.     Sept 20
  182.     Sept. 20
  183.     9/20
  184.  
  185. European French systems, on the other hand, would probably expect (try it and let me know):
  186.     20 septembre
  187.     20 sept
  188.     20 sept.
  189.     20.9
  190.  
  191. I tested how well this works in other regions, but that is the point of the routines, so I would expect them to work fairly intuitive to your language and region.
  192.  
  193. The warning-period  Field 
  194.  
  195. This is the number of days prior to the reminder’s date that you’d like the program to remind you about it. It’s a one- or two-digit number from 0 to 99. 
  196.  
  197. The number ‘0’ indicates that you want to see the reminder only on date itself—no prior days. The number ‘1’ means you want to be warned the day before in addition to on the date itself. And so on. If the reminder’s date is October 30, and the warning period is 2 days, you’ll be reminded from October 28th through October 30th.
  198.  
  199. I often set warning periods of 10 days for distant relatives for whom I need to buy a card and send it. But I may set only a 2-day warning for local friends, to remind me I will want to call them on their actual birthdays.
  200.  
  201. The Reminders  Field 
  202.  
  203. This one line of text is the line that Birthdays and Such… will show you when the reminder is valid—from the beginning of the warning period through the date of the reminder itself. It’s limited to a single line—a maximum of perhaps 70 or so characters. If you get too many, they’ll just disappear off the right edge of the window.
  204.  
  205.  
  206. Using other word processing programs to edit the Reminders file  
  207.  
  208. Here are instructions for using various common word processing programs to edit a text file. Note that the instructions may change as word processors are updated with new versions.
  209.  
  210. To use Microsoft Word, choose Open from the File menu, make sure the “List Files of Type” popup is set either to Readable Files or to Text Files, navigate to the Reminders file, select Reminders, and Open it. When you’ve made your changes, choose Save from the File menu; provided you haven’t tried (even inadvertently) to use bold, underlining, another font, or other formatting commands, Microsoft Word will maintain the TEXT file type.
  211.  
  212. If, instead, you were to start a new Reminders file in Microsoft Word, the first time you save Reminders, select Text Only in the popup menu labeled “Save File as Type”; if you forget (or if Word forgets, which it occasionally does), choose Save As... from the File menu, type in Reminders again as the filename, and select Text Only in the popup menu labeled “Save File as Type” (you’ll be prompted to confirm that it’s ok to replace the previous Reminders file). (Special power user note: As a power Word user, I have a custom Work menu; since I tend to add birthdays to Reminders all the time, as I meet people, I added Reminders to my Work menu; that way I don’t have to think about where the file is actually located—I just choose Reminders from Word’s Work menu to open it; then I edit it, save it, and close it.)  
  213.  
  214. To use MacWrite 5.01, choose Open from the File menu, navigate to the Reminders file, select Reminders, and Open it (select the “Paragraphs” button to the Carriage Return prompt; and “OK” to the Document Being Converted prompt). When you’ve made your changes, choose Save from the File menu, click the “Text Only” radio button, type in Reminders as the file’s name, and click Save. (You’ll additionally have to click Replace to “Replace existing ‘Reminders’?”; and “Paragraphs” to the Carriage Return prompt.) Then close the document in MacWrite 5.01 (you’ll additionally have to click No to “Save changes before closing?”).
  215.  
  216. To use MacWrite II, choose Open from the File menu, make sure the “Show” popup is set either to All Available or to Text, navigate to the Reminders file, select Reminders, and Open it. When you’ve made your changes, choose Save As from the File menu, set the “Save As” popup to Text, type in Reminders as the file’s name (or simply delete “ (Converted)” from after “Reminders”—be sure to remove the space character between “Reminders” and “(Converted)”), and click Save. (You’ll additionally have to click Replace to “Replace existing ‘Reminders’?”) Then close the document in MacWrite II (you’ll additionally have to click No to “Save changes to ‘Reminders (Converted)’ before closing?”).
  217.  
  218. To use MacWrite Pro, choose Open from the File menu, make sure the “Show” popup is set either to All Available or to Text, navigate to the Reminders file, select Reminders, and Open it. When you’ve made your changes, choose Save from the File menu, set the “Save As” popup to Text, type in Reminders as the file’s name (or simply delete “ (Converted)” from after “Reminders”—be sure to remove the space character between “Reminders” and “(Converted)”), and click Save. (You’ll additionally have to click Replace to “Replace existing ‘Reminders’?”) Then close the document in MacWrite Pro (you’ll additionally have to click No to “Save changes to ‘Reminders (Converted)’ before closing?”).
  219.  
  220.  
  221. To use ClarisWorks, choose Open from the File menu, set the “Document Type” popup to Word Processing (make sure the “File Type” popup is set to All Available or to Plain Text), navigate to the Reminders file, select Reminders, and Open it. When you’ve made your changes, choose Save from the File menu, set the “Save As” popup to Plain Text, type in Reminders as the file’s name (or simply delete “ - Converted” from after “Reminders”—be sure to remove the space character between “Reminders” and 
  222. “- Converted”), and click Save. (You’ll additionally have to click Replace to “Replace existing ‘Reminders’?”) Then close the document in ClarisWorks (you’ll have to click No to “Save changes to ‘Reminders - Converted’ before closing?”).
  223.  
  224. To use Microsoft Works, choose Open from the File menu, click the Word Processor icon, click the Import File check box so the Reminder icon will be visible, navigate to the Reminders file, select Reminders, and Open it. When you’ve made your changes, choose Save As from the File menu, click the Export File checkbox, type in Reminders as the file’s name, and click Save. (You’ll additionally have to click Yes to “Replace existing Reminders?”) Then close the document in Microsoft Works.
  225.  
  226. Chapter 4 : Birthdays and Such… options
  227.  
  228. Birthdays and Such… is so simple that it has only one menu option. Nonetheless, balloon help (System 7 or later) is available for Birthdays and Such… Choose Show Balloons under the Help menu to browse the capabilities of Birthdays and Such…
  229.  
  230. The AutoQuit option
  231.  
  232. Some users who launch Birthdays and Such… every day would prefer not have to look at an empty list, then manually quit the program, when there are no reminders that day. For these users, there is an AutoQuit option.
  233.  
  234. When the list of reminders is displayed, you will see, in addition to the three standard menus (the Apple, File and Edit menus), a Reminders menu. Pull down the Reminders menu and you’ll see a single option: 
  235.  
  236.     AutoQuit If No Reminders
  237.  
  238. If you choose this option, the next time you pull down the menu there will be a checkmark in front of it. And the next time you launch Birthdays and Such…, it will automatically immediately quit if there are no reminders to display.
  239.  
  240. You will want to choose this option only if you launch Birthdays and Such… daily (whether by double-clicking it, or by making it part of your Startup Items). 
  241.  
  242. If today is a date with no reminders, and the AutoQuit option is turned on, then Birthdays and Such… will launch and automatically quit. Unfortunately, the only way to disable the feature is to have Birthdays and Such… running, but it won’t run until there’s a reminder to display. Catch 22. You can solve this in one of two ways:
  243. • Change the date in the General Controls or Date & Time control panel to a date for which there is a reminder (be sure to change the date back after unchecking the AutoQuit command).
  244. • Add a reminder to the Reminders file that is applicable today.
  245.  
  246. If you leave your Macintosh running for days at a time, then you should:
  247. • leave Birthdays and Such… running all the time (its automatic update feature—re-evaluating the Reminders file at midnight every night—means that whenever you look at its window, the reminders will be correct)
  248. • leave the AutoQuit option unchecked (checking this option will stymie your intentions: Birthdays and Such… will, some midnight, hit the first hole in your reminders, quit, and never reappear)
  249.  
  250. Note: Birthdays and Such… does not know how to relaunch itself. It knows only how to update its window once it is running. I specifically designed Birthdays and Such… both to launch super quickly and/or to run all the time: it’s absolutely the smallest executable I could make it. (It’s probably the smallest executable on your machine! It’s only 17K.)
  251.  
  252. There’s one caveat to its window always being correct. If you change the Reminders file, you will have to quit and relaunch Birthdays and Such… to see the new ones. I could have added code to constantly monitor the disk and check whether the Reminders file had been changed, but opted to keep Birthdays and Such… small...
  253.